<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class SecurityConfiguration</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Interface SecurityConfiguration
</h2> (line <span class="linenumber">40</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_SecurityConfiguration.php.html">/SecurityConfiguration.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>Use this ESAPI security control to manage ESAPI security control  functions.</h5>
<div class="desc"><p>The idea behind this interface is to centralize ESAPI security control  management.</p></div>
<ul>
		<li><strong>author:</strong> - Mike Boberski &lt;<a href="mailto:boberski_michael@bah.com">boberski_michael@bah.com</a>&gt;</li>
		<li><strong>author:</strong> - Andrew van der Stock &lt;<a href="mailto:vanderaj@owasp.org">vanderaj@owasp.org</a>&gt;</li>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
            <span class="method-result">array</span>
        <a href="#methodgetAllowedExecutables" title="details" class="method-name">getAllowedExecutables</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">array</span>
        <a href="#methodgetAllowedFileExtensions" title="details" class="method-name">getAllowedFileExtensions</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetAllowedFileUploadSize" title="details" class="method-name">getAllowedFileUploadSize</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">array</span>
        <a href="#methodgetAllowedIncludes" title="details" class="method-name">getAllowedIncludes</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetAllowedLoginAttempts" title="details" class="method-name">getAllowedLoginAttempts</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">array</span>
        <a href="#methodgetAllowedResources" title="details" class="method-name">getAllowedResources</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetApplicationName" title="details" class="method-name">getApplicationName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetCharacterEncoding" title="details" class="method-name">getCharacterEncoding</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetDigitalSignatureAlgorithm" title="details" class="method-name">getDigitalSignatureAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodgetDisableIntrusionDetection" title="details" class="method-name">getDisableIntrusionDetection</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetEncryptionAlgorithm" title="details" class="method-name">getEncryptionAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetHashAlgorithm" title="details" class="method-name">getHashAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodgetLogEncodingRequired" title="details" class="method-name">getLogEncodingRequired</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetLogFileName" title="details" class="method-name">getLogFileName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetLogLevel" title="details" class="method-name">getLogLevel</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetMasterKey" title="details" class="method-name">getMasterKey</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetMasterSalt" title="details" class="method-name">getMasterSalt</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetMaxLogFileSize" title="details" class="method-name">getMaxLogFileSize</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetMaxOldPasswordHashes" title="details" class="method-name">getMaxOldPasswordHashes</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetPasswordParameterName" title="details" class="method-name">getPasswordParameterName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetQuota" title="details" class="method-name">getQuota</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$eventName</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetRandomAlgorithm" title="details" class="method-name">getRandomAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetRememberTokenDuration" title="details" class="method-name">getRememberTokenDuration</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetResourceDirectory" title="details" class="method-name">getResourceDirectory</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetResponseContentType" title="details" class="method-name">getResponseContentType</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetSessionAbsoluteTimeoutLength" title="details" class="method-name">getSessionAbsoluteTimeoutLength</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">int</span>
        <a href="#methodgetSessionIdleTimeoutLength" title="details" class="method-name">getSessionIdleTimeoutLength</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetUsernameParameterName" title="details" class="method-name">getUsernameParameterName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetValidationPattern" title="details" class="method-name">getValidationPattern</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">string</span>
        <a href="#methodgetWorkingDirectory" title="details" class="method-name">getWorkingDirectory</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">Does</span>
        <a href="#methodsetResourceDirectory" title="details" class="method-name">setResourceDirectory</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="methodgetAllowedExecutables" id="methodgetAllowedExecutables"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedExecutables</strong> (line <span class="linenumber">305</span>)
 </h4> 
<h4><i>array</i> <strong>getAllowedExecutables(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>getAllowedExecutables returns an array of executables that are allowed to  be run by the Executor.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - an array of executable names</li>
		</ul>
</div>
<a name="methodgetAllowedFileExtensions" id="methodgetAllowedFileExtensions"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedFileExtensions</strong> (line <span class="linenumber">72</span>)
 </h4> 
<h4><i>array</i> <strong>getAllowedFileExtensions(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the allowed file extensions for files that are uploaded to this  application.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - a list of the current allowed file extensions</li>
		</ul>
</div>
<a name="methodgetAllowedFileUploadSize" id="methodgetAllowedFileUploadSize"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedFileUploadSize</strong> (line <span class="linenumber">79</span>)
 </h4> 
<h4><i>int</i> <strong>getAllowedFileUploadSize(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the maximum allowed file upload size.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current allowed file upload size</li>
		</ul>
</div>
<a name="methodgetAllowedIncludes" id="methodgetAllowedIncludes"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedIncludes</strong> (line <span class="linenumber">155</span>)
 </h4> 
<h4><i>array</i> <strong>getAllowedIncludes(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>getAllowedIncludes returns an array of include files that are allowed to be  included by PHP. This is a ESAPI extension for PHP</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - an array of allowed includes</li>
		</ul>
</div>
<a name="methodgetAllowedLoginAttempts" id="methodgetAllowedLoginAttempts"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedLoginAttempts</strong> (line <span class="linenumber">147</span>)
 </h4> 
<h4><i>int</i> <strong>getAllowedLoginAttempts(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the number of login attempts allowed before the user's account is  locked. If this many failures are detected within the alloted time period,  the user's account will be locked.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the number of failed login attempts that cause an account to be              locked</li>
		</ul>
</div>
<a name="methodgetAllowedResources" id="methodgetAllowedResources"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedResources</strong> (line <span class="linenumber">164</span>)
 </h4> 
<h4><i>array</i> <strong>getAllowedResources(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>getAllowedResources returns an array of resources (files) that are permitted.</h5>
<div class="desc"><p>This is a new addition for the ESAPI for PHP project, but may be relevant  for other ports, too.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - an array of allowed resources</li>
		</ul>
</div>
<a name="methodgetApplicationName" id="methodgetApplicationName"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getApplicationName</strong> (line <span class="linenumber">48</span>)
 </h4> 
<h4><i>string</i> <strong>getApplicationName(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the application name, used for logging</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the name of the current application</li>
		</ul>
</div>
<a name="methodgetCharacterEncoding" id="methodgetCharacterEncoding"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getCharacterEncoding</strong> (line <span class="linenumber">121</span>)
 </h4> 
<h4><i>string</i> <strong>getCharacterEncoding(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the character encoding scheme supported by this application. This is</h5>
<div class="desc"><p>used to set the character encoding scheme on requests and responses when  setCharacterEncoding() is called on SafeRequests and SafeResponses. This  scheme is also used for encoding/decoding URLs and any other place where  the current encoding scheme needs to be known.  <br /><br />  Note: This does not get the configured response content type. That is  accessed by calling getResponseContentType().</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current character encoding scheme</li>
		</ul>
</div>
<a name="methodgetDigitalSignatureAlgorithm" id="methodgetDigitalSignatureAlgorithm"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getDigitalSignatureAlgorithm</strong> (line <span class="linenumber">129</span>)
 </h4> 
<h4><i>string</i> <strong>getDigitalSignatureAlgorithm(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the digital signature algorithm used by ESAPI to generate and verify  signatures.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current digital signature algorithm</li>
		</ul>
</div>
<a name="methodgetDisableIntrusionDetection" id="methodgetDisableIntrusionDetection"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getDisableIntrusionDetection</strong> (line <span class="linenumber">190</span>)
 </h4> 
<h4><i>bool</i> <strong>getDisableIntrusionDetection(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Allows for complete disabling of all intrusion detection mechanisms.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true if intrusion detection should be disabled.</li>
		</ul>
</div>
<a name="methodgetEncryptionAlgorithm" id="methodgetEncryptionAlgorithm"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getEncryptionAlgorithm</strong> (line <span class="linenumber">100</span>)
 </h4> 
<h4><i>string</i> <strong>getEncryptionAlgorithm(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the encryption algorithm used by ESAPI to protect data.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current encryption algorithm</li>
		</ul>
</div>
<a name="methodgetHashAlgorithm" id="methodgetHashAlgorithm"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getHashAlgorithm</strong> (line <span class="linenumber">107</span>)
 </h4> 
<h4><i>string</i> <strong>getHashAlgorithm(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the hashing algorithm used by ESAPI to hash data.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current hashing algorithm</li>
		</ul>
</div>
<a name="methodgetLogEncodingRequired" id="methodgetLogEncodingRequired"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogEncodingRequired</strong> (line <span class="linenumber">253</span>)
 </h4> 
<h4><i>bool</i> <strong>getLogEncodingRequired(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns whether HTML entity encoding should be applied to log entries.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - True if log entries are to be HTML Entity encoded. False               otherwise.</li>
		</ul>
</div>
<a name="methodgetLogFileName" id="methodgetLogFileName"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogFileName</strong> (line <span class="linenumber">270</span>)
 </h4> 
<h4><i>string</i> <strong>getLogFileName(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Get the name of the log file specified in the ESAPI configuration properties  file. Return a default value if it is not specified.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the log file name defined in the properties file.</li>
		</ul>
</div>
<a name="methodgetLogLevel" id="methodgetLogLevel"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogLevel</strong> (line <span class="linenumber">262</span>)
 </h4> 
<h4><i>int</i> <strong>getLogLevel(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Get the log level specified in the ESAPI configuration properties file.</h5>
<div class="desc"><p>Return a default value if it is not specified in the properties file.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the logging level defined in the properties file. If none is              specified, the default of Logger.WARNING is returned.</li>
		</ul>
</div>
<a name="methodgetMasterKey" id="methodgetMasterKey"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMasterKey</strong> (line <span class="linenumber">56</span>)
 </h4> 
<h4><i>string</i> <strong>getMasterKey(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the master password. This password can be used to encrypt/decrypt other  files or types of data that need to be protected by your application.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current master password</li>
		</ul>
</div>
<a name="methodgetMasterSalt" id="methodgetMasterSalt"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMasterSalt</strong> (line <span class="linenumber">64</span>)
 </h4> 
<h4><i>string</i> <strong>getMasterSalt(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the master salt that is used to salt stored password hashes and any  other location where a salt is needed.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current master salt</li>
		</ul>
</div>
<a name="methodgetMaxLogFileSize" id="methodgetMaxLogFileSize"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMaxLogFileSize</strong> (line <span class="linenumber">279</span>)
 </h4> 
<h4><i>int</i> <strong>getMaxLogFileSize(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Get the maximum size of a single log file from the ESAPI configuration  properties file. Return a default value if it is not specified. Once the  log hits this file size, it will roll over into a new log.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the maximum size of a single log file (in bytes).</li>
		</ul>
</div>
<a name="methodgetMaxOldPasswordHashes" id="methodgetMaxOldPasswordHashes"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMaxOldPasswordHashes</strong> (line <span class="linenumber">173</span>)
 </h4> 
<h4><i>int</i> <strong>getMaxOldPasswordHashes(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the maximum number of old password hashes that should be retained.</h5>
<div class="desc"><p>These hashes can be used to ensure that the user doesn't reuse the specified  number of previous passwords when they change their password.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the number of old hashed passwords to retain</li>
		</ul>
</div>
<a name="methodgetPasswordParameterName" id="methodgetPasswordParameterName"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getPasswordParameterName</strong> (line <span class="linenumber">86</span>)
 </h4> 
<h4><i>string</i> <strong>getPasswordParameterName(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the name of the password parameter used during user authentication.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the name of the password parameter</li>
		</ul>
</div>
<a name="methodgetQuota" id="methodgetQuota"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getQuota</strong> (line <span class="linenumber">183</span>)
 </h4> 
<h4><i>int</i> <strong>getQuota(
string
$eventName)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the intrusion detection quota for the specified event.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $eventName</strong>: the name of the event whose quota is desired</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the Quota that has been configured for the specified type of              event</li>
		</ul>
</div>
<a name="methodgetRandomAlgorithm" id="methodgetRandomAlgorithm"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomAlgorithm</strong> (line <span class="linenumber">137</span>)
 </h4> 
<h4><i>string</i> <strong>getRandomAlgorithm(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the random number generation algorithm used to generate random numbers  where needed.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the current random number generation algorithm</li>
		</ul>
</div>
<a name="methodgetRememberTokenDuration" id="methodgetRememberTokenDuration"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRememberTokenDuration</strong> (line <span class="linenumber">224</span>)
 </h4> 
<h4><i>int</i> <strong>getRememberTokenDuration(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the length of the time to live window for remember me tokens (in  milliseconds).</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - The time to live length for generated remember me tokens.</li>
		</ul>
</div>
<a name="methodgetResourceDirectory" id="methodgetResourceDirectory"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getResourceDirectory</strong> (line <span class="linenumber">197</span>)
 </h4> 
<h4><i>string</i> <strong>getResourceDirectory(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the name of the ESAPI resource directory as a String.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - The ESAPI resource directory.</li>
		</ul>
</div>
<a name="methodgetResponseContentType" id="methodgetResponseContentType"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getResponseContentType</strong> (line <span class="linenumber">216</span>)
 </h4> 
<h4><i>string</i> <strong>getResponseContentType(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the content type for responses used when setSafeContentType() is called.</h5>
<div class="desc"><p><br /><br />  Note: This does not get the configured character encoding scheme. That is  accessed by calling getCharacterEncoding().</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - The current content-type set for responses.</li>
		</ul>
</div>
<a name="methodgetSessionAbsoluteTimeoutLength" id="methodgetSessionAbsoluteTimeoutLength"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getSessionAbsoluteTimeoutLength</strong> (line <span class="linenumber">245</span>)
 </h4> 
<h4><i>int</i> <strong>getSessionAbsoluteTimeoutLength(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the absolute timeout length for sessions (in milliseconds). This is</h5>
<div class="desc"><p>the amount of time that a session can live before it expires regardless  of the amount of user activity. Applications or frameworks could provide a  reauthenticate function that enables a session to continue after  reauthentication.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - The session absolute timeout length.</li>
		</ul>
</div>
<a name="methodgetSessionIdleTimeoutLength" id="methodgetSessionIdleTimeoutLength"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getSessionIdleTimeoutLength</strong> (line <span class="linenumber">234</span>)
 </h4> 
<h4><i>int</i> <strong>getSessionIdleTimeoutLength(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the idle timeout length for sessions (in milliseconds). This is the  amount of time that a session can live before it expires due to lack of  activity. Applications or frameworks could provide a reauthenticate  function that enables a session to continue after reauthentication.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - The session idle timeout length.</li>
		</ul>
</div>
<a name="methodgetUsernameParameterName" id="methodgetUsernameParameterName"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getUsernameParameterName</strong> (line <span class="linenumber">93</span>)
 </h4> 
<h4><i>string</i> <strong>getUsernameParameterName(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the name of the username parameter used during user authentication.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the name of the username parameter</li>
		</ul>
</div>
<a name="methodgetValidationPattern" id="methodgetValidationPattern"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getValidationPattern</strong> (line <span class="linenumber">289</span>)
 </h4> 
<h4><i>string</i> <strong>getValidationPattern(
string
$type)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Get the specified validation pattern from the ESAPI configuration properties  file.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $type</strong>: validation pattern name</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the regular expression.</li>
		</ul>
</div>
<a name="methodgetWorkingDirectory" id="methodgetWorkingDirectory"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getWorkingDirectory</strong> (line <span class="linenumber">297</span>)
 </h4> 
<h4><i>string</i> <strong>getWorkingDirectory(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>getWorkingDirectory returns the default directory where processes will be  executed by the Executor.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - working directory name</li>
		</ul>
</div>
<a name="methodsetResourceDirectory" id="methodsetResourceDirectory"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setResourceDirectory</strong> (line <span class="linenumber">206</span>)
 </h4> 
<h4><i>Does</i> <strong>setResourceDirectory(
string
$dir)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Sets the ESAPI resource directory.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $dir</strong>: The location of the resource directory.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Fri, 21 May 2010 14:53:43 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>